This folder contains the principal developer documentation for OpenDoc for the MacOS. The subfolders contain the following documents:
Class Reference
Contains the OpenDoc Class Reference, in two formats: (1) Adobe Acrobat™, indexed for full text search, and (2) QuickView™, which gives you hypertext access to the OpenDoc API descriptions in the same manner as Macintosh Programmer's Toolbox Assistant.
See below for installation and usage instructions for both Acrobat and QuickView.
Programmer's Guide
Contains the OpenDoc Programmer's Guide, in Adobe Acrobat™ format, indexed for full text search.
Cookbook
Contains the OpenDoc Cookbook, in Adobe Acrobat™ format.
Human Interface
Contains the Drag and Drop Human Interface Guidelines, in Adobe Acrobat™ format. It contains interface-behavior guidelines for Macintosh drag and drop. OpenDoc human interface guidelines, which were previously in this folder, are now part of the Programmer's Guide.
NOTE: All documentation is preliminary, and may contain errors. The information is in some cases incomplete and is not guaranteed to be current with the version of OpenDoc that ships with this seed.
INSTALLING ACROBAT EXCHANGE LE
To view the documents in this folder, you must first install Adobe Acrobat Exchange LE onto your system. Adobe Acrobat Exchange LE is similar to Acrobat Reader (shipped with previous OpenDoc developer releases), except that it has additional features, notably the capability for fast, fully indexed text search (called Acrobat Search). Follow these steps to install Exchange LE:
1. Find the Adobe Acrobat Exchange LE folder in the Utilities folder on this CD.
You can drag it to your hard disk before installing, if you wish.
2. Launch the Installer, located withn the Disk 1 folder within the Adobe Acrobat
Exchange LE folder. Read the license agreement, and click Continue.
3. The Installer creates a folder named "Adobe Acrobat 2.0" on your hard disk,
and installs version 2.0.1 of Exchange LE, version 2.0 of Acrobat Search
(in the Plug-Ins folder within the Adobe Acrobat 2.0 folder), a Help folder,
a Tutorial folder, and an Optional Plug-Ins folder. It also installs some fonts
and a version of ATM (if necessary).
4. When installation completes, click Restart to restart your machine.
(If you have QuickDraw GX installed on your machine, see the additional installation instructions in the "ReadMe-ExchangeLE.pdf" file in the Help folder within your
Adobe Acrobat 2.0 folder.)
You can now read any of the Acrobat documents on this CD. Acrobat documents are recognizable because their icons display the letters "PDF". Also, their filenames commonly—although not necessarily—have a .pdf suffix.
USING ACROBAT EXCHANGE LE
The Help folder in your Adobe Acrobat 2.0 folder contains an Acrobat document ("Help-ExchangeLE.pdf") that describes how to use Exchange LE. But here are some of the basics, plus some notes specific to the documents in this folder:
• Launch any Acrobat file by double-clicking on it. By default it opens at 100%,
but you can change the magnification in various ways. You can use the
Preferences command in the File menu to change the default magnification
(as well as other settings) that a document uses when first opened .
NOTE 1: The documents in this folder may not display well at 125%; some
characters may be distorted. Viewing at another magnification, such as100% or
120%, is preferable. (You can even specify a custom size, such as 137%).
NOTE 2: Screen-shot graphics may not display well at 100% (although they
will print correctly). Viewing at a higher magnification (such as 200%) should
solve the problem.
• You can navigate through the document page-by-page or in larger jumps, by clicking
on several kinds of arrow buttons in the tool bar at the top of the screen, by using
commands in the View menu, by using the window scroll bars, or by using the
arrow keys on the keyboard.
• Some documents have bookmarks that aid navigation. The bookmark list functions
as a hypertext table of contents. To display or hide the bookmark list, use the
leftmost two buttons in the toolbar across the top of the screen.
• Some documents have hypertext jumps within their tables of contents, indexes,
and in cross-references throughout their body text. The presence of a hypertext
jump is indicated by the cursor changing shape to a hand with extended
index finger. Click once on the hypertext element to jump to its destination.
• You can select either text or graphics to copy to the Clipboard. (You cannot use
Exchange LE to cut from a document or paste into it.)
• Exchange LE supports a simple Find command, accessed from the Tools menu.
However, it also supports a very powerful and fast search tool, described next.
USING ACROBAT SEARCH
The Help folder in your Adobe Acrobat 2.0 folder contains an Acrobat document ("Help-Search.pdf") that describes how to use Acrobat Search. Basically, you access the search feature from the Search item in Tools menu:
1. To get started, you must first select the search index(es) to include.
Select the Indexes command from the Search item, and choose the index
OPENDOC.PDX; it is in the OpenDoc Index folder.
2. Once you have selected the index, you can then create a query in the Search
window with the Query command, or the Search Query button in the toolbar.
Acrobat Search supports complex queries that can include phrases, Booleans,
and wildcards. You can limit the search to specific indexed documents, and
you can select options such as word-stemming, case sensitivity, and proximity.
3. The results of your search are shown as a list of file names in the Search
Results window, ranked by relevance. You can select any of the files and
double-click on it, and then use the Search Next and Search Previous buttons
in the toolbar to look at successive occurrences of the search term.
INSTALLING QUICKVIEW
The OpenDoc Class Reference is also available as a QuickView database, named "OpenDoc Class Ref (QuickView)". The OpenDoc Class Reference database gives you rapid access to up-to-date information about the OpenDoc API. It provides a complete reference to all OpenDoc classes, methods, types, and constants. It includes extensive hypertext links for rapid, easy navigation and provides useful features such as copy text, fast full-text search, user annotations, and resizable windows.
To install QuickView, copy the OpenDoc Class Ref (qv) folder to your hard drive. The folder contains the QuickView application, a Help file, and the OpenDoc Class Reference database. For the current version of QuickView, the QuickView application and any of its databases must reside in the same folder.
USING QUICKVIEW
If you have questions on how to use QuickView and its databases, you can consult the QuickView Help file, accessed through the Help menu when QuickView is active. For this release, only the Macintosh Programmer's Toolbox Assistant Help file is available. That Help file explains correctly how to use QuickView, but it does not accurately describe the organization of the OpenDoc Class Reference database. Note especially these differences:
• The Class Reference is organized by Class, not Manager.
• Descriptions of methods whose names are not unique (such as First) are
accessed though a popup, allowing you to choose the fully qualified
